package com.example.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Copyright(C), 2020-2021, AmbroseCdMeng
 * FileName:    Swagger2Configuration
 * Author:      AmbroseCdMeng
 * Date:        2021/2/211:29
 * Description: Swagger 配置类
 *              与 SpringBoot 集成时，放在 Application.java 同级目录下
 *              通过注解 @Configuration 让 Spring 来加载该类配置
 *              再通过注解 @EnableSwagger2 来启用 Swagger2
 *
 * History:
 * <author>     <time>      <version>       <desc>
 * 作者姓名     修改时间        版本号           描述
 */
@Configuration // 让 Spring 来加载该类配置
 public class Swagger2Config implements WebMvcConfigurer {

    /**
     * 创建 API 应用
     * apiInfo 增加 API 相关信息
     * 通过 select() 函数返回一个 ApiSelectorBuilder 实例，用来控制哪些接口暴露给 Swagger 来展现
     * 本例采用指定扫描的包路径来定义指定要建立 API 的目录
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) // 用来展示该 API 的基本信息
                .select()   // 返回一个 ApiSelectorBuilder 实例，用来控制哪些接口暴露给 Swagger 来展现
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))   // 配置包扫描路径
                .paths(PathSelectors.any()) //
                .build();
    }

    /**
     * 创建 API 的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://xxx/swagger-ui.html
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("RESTful APIs")
                .description("RESTful APIs")
                .termsOfServiceUrl("http://localhost:8080/")
                .contact(new Contact("ambrose", "swagger.example", "123@456.com"))
                .version("1.0")
                .build();
    }
}
